home *** CD-ROM | disk | FTP | other *** search
/ Amiga Plus 2000 #1 / Amiga Plus CD - 2000 - No. 1.iso / Tools / Text / Edit / GoldED-Demo / Bonus / RA / developer / library / autodoc / remote.doc
Encoding:
Text File  |  1999-12-03  |  3.3 KB  |  162 lines
  1. TABLE OF CONTENTS
  2.  
  3. remote.library/RemoteInit
  4. remote.library/RemoteAdd   
  5. remote.library/RemoteRemove
  6. remote.library/RemoteOpen
  7. remote.library/RemoteValidate
  8.  
  9. remote.library/RemoteInit                 remote.library/RemoteInit
  10.  
  11.     NAME
  12.         RemoteInit - Initialize remote.library (optional)
  13.  
  14.     SYNOPSIS
  15.         error = RemoteInit()
  16.  
  17.         int error = RemoteInit(void)
  18.              D0
  19.     FUNCTION
  20.         Initializes library before first use (optional)
  21.  
  22.     INPUTS
  23.  
  24.     RESULTS
  25.         error - error code or 0 if successful
  26.  
  27.     SEE ALSO
  28.         RemoteError
  29.  
  30.     BUGS
  31.  
  32.  
  33. remote.library/RemoteAdd                  remote.library/RemoteAdd
  34.  
  35.     NAME
  36.         RemoteAdd - add new application to database
  37.  
  38.     SYNOPSIS
  39.         error = RemoteAdd(config)
  40.  
  41.         int error = RemoteAdd(char *)
  42.              D0                A0
  43.     FUNCTION
  44.         Adds a new application entry to the database of supported
  45.         applications.
  46.  
  47.     INPUTS
  48.         config - application configuration string (LF-terminated)
  49.  
  50.     RESULTS
  51.         error - error code or 0 if successful
  52.  
  53.     SEE ALSO
  54.         RemoteError
  55.  
  56.     BUGS
  57.  
  58. remote.library/RemoteRemove               remote.library/RemoteRemove
  59.  
  60.     NAME
  61.         RemoteRemove - remove application from database
  62.  
  63.     SYNOPSIS
  64.         error = RemoteRemove(appname)
  65.  
  66.         int error = RemoteRemove(char *appname)
  67.              D0                       A0
  68.  
  69.     FUNCTION
  70.         Removes specified application(s) from the database of supported
  71.         applications.
  72.  
  73.     INPUTS
  74.         appname - application name; may contain wildcards
  75.  
  76.     RESULTS
  77.         error - error code or 0 if successful
  78.  
  79.     SEE ALSO
  80.         RemoteError
  81.  
  82.     BUGS
  83.  
  84.  
  85. remote.library/RemoteOpen                 remote.library/RemoteOpen
  86.  
  87.     NAME
  88.         RemoteOpen - open file in a remote application
  89.  
  90.     SYNOPSIS
  91.         error = RemoteOpen(class, appname, file, flags)
  92.  
  93.         int error = RemoteOpen(char *, char *, char *, int)
  94.              D0                 A0      A1      D0      D1
  95.  
  96.     FUNCTION
  97.         Open specified file
  98.  
  99.     INPUTS
  100.         class   - application class
  101.         appname - application name (or NULL); may contain wildcards
  102.         file    - file to open (or NULL)
  103.         flags   - flags (see remote.h)
  104.  
  105.     RESULTS
  106.         error - error code or 0 if successful
  107.  
  108.     SEE ALSO
  109.         RemoteError
  110.  
  111.     BUGS
  112.  
  113.  
  114. remote.library/RemoteError                remote.library/RemoteError
  115.  
  116.     NAME
  117.         RemoteError - return the text associated with an error code
  118.  
  119.     SYNOPSIS
  120.         text = RemoteError(error)
  121.  
  122.         char text = RemoteError(int error)
  123.               D0                D0
  124.  
  125.     FUNCTION
  126.         Returns the text associated with an error code
  127.  
  128.     INPUTS
  129.         error - error code
  130.  
  131.     RESULTS
  132.         text - error text
  133.  
  134.     SEE ALSO
  135.  
  136.     BUGS
  137.  
  138. remote.library/RemoteValidate             remote.library/RemoteValidate
  139.  
  140.     NAME
  141.         RemoteValidate - rebuild application database
  142.  
  143.     SYNOPSIS
  144.         error = RemoteValidate(folder, flags)
  145.  
  146.         int error = RemoteValidate(char *folder, int flags)
  147.             D0                         A0           D0
  148.  
  149.     FUNCTION
  150.         Scans specified folder and rebuilds application database
  151.  
  152.     INPUTS
  153.         folder - directory name (or NULL for all drives)
  154.         flags  - flags (see remote.h)
  155.  
  156.     RESULTS
  157.         error - error code or 0 if successful
  158.  
  159.     SEE ALSO
  160.  
  161.     BUGS
  162.